Run(LEADDocument,List<IMasterFormsCategory>) Method

Summary

Recognizes the documents within LEADDocument and any fields in the document pages.

Syntax

C++/CLI

Java

Python

public AutoFormsRunResult Run( 
   LEADDocument leadDoc, 
   List<IMasterFormsCategory> categories 
)

public AutoFormsRunResult run( 
   LEADDocument,  
   java.util.List<IMasterFormsCategory> 
);

public:  
   AutoFormsRunResult^ Run( 
      LEADDocument^ leadDoc, 
      List<IMasterFormsCategory^>^ categories 
   )

def Run(self,leadDoc,categories):

Parameters

leadDoc

The LEADDocument object to recognize.

categories

List of Master Forms categories to use in comparison, pass null or empty to use all Master Forms in the repository.

Return Value

Returns the results of the recognition and processing if the form is recognized; otherwise it returns null. If the Master Form has no processing field, AutoFormsRunResult.FormFields will be null.

Remarks

This method automatically recognizes the unknown form and its fields at the same time.

If RecognizeFirstPageOnly is true, the recognition will be performed based on the first page only. Otherwise, false to recognize over all the form pages.

When RecognizeFirstPageOnly is set to true and the recognition to perform is based on the first page only, then leadDoc should have at least the first page of the form to recognize.

If the form is not recognized, it will return null. If the Master Form of the leadDoc type does not contain any fields, then AutoFormsRunResult.FormFields will be null.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Forms.Auto; 
using Leadtools.Document; 
using Leadtools.Ocr; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Processing; 
using Leadtools.Barcode; 
 
 
public void AutoFormRunLEADDoc() 
{ 
   string root = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\FormsDemo\OCR_Test"); 
   RasterCodecs codecs = new RasterCodecs(); 
   //create repository 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      //create AutoForm Engine 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine, AutoFormsRecognitionManager.Ocr | AutoFormsRecognitionManager.Default, 30, 80, true); 
 
      // Load the LEADDocument from file with default options 
      LoadDocumentOptions loadOptions = new LoadDocumentOptions(); 
      LEADDocument leadDoc = DocumentFactory.LoadFromFile(Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Forms to be Recognized\OCR\FCC-107_OCR_Filled.tif"), loadOptions); 
 
      //recognize and process the form 
      AutoFormsRunResult result = autoEngine.Run(leadDoc, null); 
      if (result == null) 
         return; 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS22\Bin\Common\OcrLEADRuntime"; 
}

Requirements

Target Platforms